Interface SshServerProcess

All Superinterfaces:
IPCObject, Process, TelnetServerProcess
All Known Implementing Classes:
SshServerProcessImpl

public interface SshServerProcess extends TelnetServerProcess
Information provided by the PKI file:

    \class SshServerProcess
    
    \brief SshServerProcess handles and manipulates the SSH service.
    
    \example network().getDevice("Router0").getProcess("TelnetServer")
    
Author:
Auto-generated
  • Method Details

    • setVersion

      void setVersion(SshVersion version)
      Information provided by the PKI file:
      
          \brief Sets the SSH version.
          
          \param version, the SSH version.
          SSH versions:       shVerDefault = 0,
          sshVerOne = 1,
          sshVerTwo = 2
          
              
      Parameters:
      version - Takes in a parameter of version
    • getVersion

      SshVersion getVersion()
      Information provided by the PKI file:
      
          \brief Returns the SSH version.
          
          \return Ssh::SshVersion,    the SSH version.
          SSH versions:       shVerDefault = 0,
          sshVerOne = 1,
          sshVerTwo = 2
          
              
      Returns:
      SshVersion Returns a SshVersion
    • isUsernameReceived

      boolean isUsernameReceived()
      Information provided by the PKI file:
      
          \brief Returns true if the username is received, otherwise false.
          
          \return bool, true if the username is received, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • usernameReceived

      void usernameReceived(boolean usernameReceived)
      Information provided by the PKI file:
      
          \brief Sets the username as received or not received.
          
          \param usernameReceived, true for received, false for not received.
          
              
      Parameters:
      usernameReceived - Takes in a parameter of usernameReceived
    • setRetryAmount

      void setRetryAmount(int amt)
      Information provided by the PKI file:
      
          \brief Sets the retry amount.
          
          \param amt, the retry amount.
          
              
      Parameters:
      amt - Takes in a parameter of amt
    • getRetryAmount

      int getRetryAmount()
      Information provided by the PKI file:
      
          \brief Returns the retry amount.
          
          \return int, the retry amount.
          
              
      Returns:
      int Returns a int
    • setAuthTimeout

      void setAuthTimeout(int sec)
      Information provided by the PKI file:
      
          \brief Sets the authentication timeout.
          
          \param sec, the authentication timeout.
          
              
      Parameters:
      sec - Takes in a parameter of sec
    • getAuthTimeout

      int getAuthTimeout()
      Information provided by the PKI file:
      
          \brief Returns the authentication timeout.
          
          \param int, the authentication timeout.
          
              
      Returns:
      int Returns a int